Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: schemaDataAsync #885

Draft
wants to merge 13 commits into
base: refactor/develop
Choose a base branch
from
Draft

feat: schemaDataAsync #885

wants to merge 13 commits into from

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Oct 29, 2024 •
edited
Loading

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Feature
  • Bugfix
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

【背景&问题】What is the current behavior?

  1. 当前对 schema 的修改都是直接对画布内的 schema 引用进行修改。
  2. 画布外的主进程 host 与画布内是两个 vue 实例。导致 host 主进程无法主动监听到最新 schema 的变化。
    • 比如大纲树无法观察到元素的拖拽删除，及时渲染最新的大纲树。
    • 比如 schema 面板无法实时观察到画布的变化，只能在打开面板的时候，才获取最新的 schema。
  3. 其他插件有观察 schema 变化的场景，当前都无法满足。

【解决方案】What is the new behavior?

统一 schema 修改入口 + schema 变更事件发布订阅 + jsondiff 同步差异
image

【PR主要改动点】

  1. 修改 schema 统一入口。
    以往修改 schema 的方法：直接 schema.props = xxx ，即拿到引用直接进行修改
    当前 schema 修改的入口改为：

    • useCanvas().opeateNode(operation) 主要用于操作节点删除、节点新增、节点 props 属性修改。
    • useCanvas().updateSchema(data) 主要用于更新 schema 的 state、css、method、lifecycles 等非节点属性。
    • useCanvas().importSchema(data) 主要用于页面、区块之间的切换。

  2. 事件通知 schema 改变事件。

    • schemaChange 事件。调用 opeateNode 以及 updateSchema 会触发该事件的发布。
    • schemaImport 事件。调用 importSchema 会触发该事件的发布。

  3. 修改 utils、bridge、globalState、dataSourceMap 等入口从直接修改画布改为直接修改 useResource 中的 appSchemaState

  4. 画布 RenderMain 减少相关 schema 的操作接口（修改移动到统一的页面修改入口以及 appSchema 修改）

    • 减少的相关接口：setUtils、updateUtils、deleteUtils、getBridge、setBridge、getMethods、setMethods、getSchema、setSchema、getState、deleteState、setState、getProps、setProps、getContext、getRoot、getNode、setNode、getCondition、getGlobalState、setGlobalState、getDataSourceMap、setDataSourceMap

  5. 画布对 schema 变更的状态的感知，改为 schema 相关修改事件的监听以及状态的订阅。

  6. 语义化重命名：resState 改为 appSchemaState

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024 •
edited
Loading

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added enhancement New feature or request refactor-main refactor/develop branch feature labels Oct 29, 2024
@chilingling chilingling added the refactoring Refactoring label Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request refactor-main refactor/develop branch feature refactoring Refactoring
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@chilingling